manifest.json for UI apps
manifest.json file consists of both service metadata app settings. App settings can be configured through publishing app with updated manifest.json.
Manifest file consists of:
- application.type - is a service field required by Corva. Cannot be changed.
- application.key - is the app key used by Corva to identify the app. Cannot be changed.
- application.visibility - service field. To be updated.
- application.name - name of your app. Used in the standard App Header, App Settings, Corva App Store and Devcenter. Can be changed through publishing the app with updated manifest.json or through the DevCenter app page.
- application.category - preselected app category. Cannot be changed.
- application.segments - currently two segments are available. drilling and completions. App will receive rig/well in app props if drilling segment is selected or fracfleet/fracfleet wells otherwise.
- application.ui.initial_size.w - initial width of the app once added to dashboard. Corva dashboard is divided into 12 columns, app width can vary in the range from 1 to 12.
- application.ui.initial_size.h - initial app height. Can be from 1 to any value. Too big value will lead to dashboard scroll.
- application.ui.multi_rig - multi rig concept for apps. Values are: true or false. Multi rig app has no asset selector and doesn't receive rig/well in props. It's expected that multi_rig app fetches all the data it needs by itself.
- application.ui.disableActiveWellsInPadSelect - is a boolean parameter that disables all not active wells in pad select if true. Only for completions. False by default.
- application.ui.enableSimulFracInPadSelect - is a boolean parameter that enables simul frac pad view for pad mode selector. Used used for realtime completion apps. False by default.
- application.ui.full_screen_report - when true, app will take space of the whole page on the PDF report
- settings - service config. To be updated.
- datasets - service field. To be updated.
Example manifest for UI apps:
{
"format": 1,
"license": {
"type": "MIT",
"url": "https://www.oandgexample.com/license/"
},
"developer": {
"authors": []
},
"application": {
"type": "ui",
"key": "example-provider.example_app_name.ui",
"visibility": "private",
"name": "Example app name", // NOTE: App name. You can override app name here or through the UI
"category": "analytics",
"segments": [
"drilling" // NOTE: Can be "drilling" or "completion"
],
"ui": {
"initial_size": {
"w": 4, // NOTE: initial app width
"h": 10 // NOTE: initial app height
},
"multi_rig": false, // NOTE: Is app multi_rig ?
"disableActiveWellsInPadSelect": false // NOTE: only for COMPLETIONS, will disable all not active wells in pad select if true.
}
},
"settings": {
// NOTE: Service field. Should not be changed.
"entrypoint": {
"file": "src/index.js",
"function": "handler"
},
"environment": {},
"runtime": "ui"
},
"datasets": {} // NOTE: To be updated
}